From: Alexander Schaefer <fudger@users.noreply.github.com>
Date: Thu, 10 Mar 2016 20:55:01 +0000 (+0100)
Subject: Add readme
X-Git-Tag: archive/raspbian/1.68-2+rpi1~88^2^2~1
X-Git-Url: https://dgit.raspbian.org/%22http://www.example.com/cgi/%22/%22http:/www.example.com/cgi/%22?a=commitdiff_plain;h=c28367d2c83d4462ed11ed810c910f25dc7c797e;p=pigpio.git

Add readme
---

diff --git a/util/readme.md b/util/readme.md
new file mode 100644
index 0000000..6cd58dd
--- /dev/null
+++ b/util/readme.md
@@ -0,0 +1,31 @@
+This folder provides utility files for the pigpio library.
+
+### pigpiod
+
+`pigpiod` is a script that allows to run pigpiod as a Linux service with root privileges.
+The advantage of running pigpiod as a service is that pigpiod can be automatically launched on system startup.
+To automatically start pigpiod as a service, do the following:
+
++ Copy `pigpiod` from this directory to `/etc/init.d/`.
+
++ Make it executable: 
+  ```
+  sudo chmod +x /etc/init.d/pigpiod
+  ```
+
++ Tell update-rc.d to automatically start the pigpiod service on system startup:
+  ```
+  sudo update-rc.d skeleton defaults
+  ```
+  
++ Now, you can start, stop, and restart pigpiod using
+  ```
+  sudo service pigpiod start
+  sudo service pigpiod stop
+  sudo service pigpiod restart
+  ```
+
+
+### Findpigpio.cmake
+
+`Findpigpio.cmake` is a script used by CMake to find out where the pigpio header and library files are located.